<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->

<title>bkgrnd</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<h4><a name = "tag_002_001_406">&nbsp;</a>NAME</h4><blockquote>
bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd
- turn off
the previous background attributes, OR the requested attributes
into the window rendition, and
set or get background character and rendition using a complex character
</blockquote><h4><a name = "tag_002_001_407">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

#include &lt;<a href="curses.h.html">curses.h</a>&gt;

int bkgrnd(const cchar_t *<i>wch</i>);

void bkgrndset(const cchar_t *<i>wch</i>);

int getbkgrnd(cchar_t *<i>wch</i>);

int wbkgrnd(WINDOW *<i>win</i>, const cchar_t *<i>wch</i>);

void wbkgrndset(WINDOW *<i>win</i>, const cchar_t *<i>wch</i>);

int wgetbkgrnd(WINDOW *<i>win</i>, cchar_t *<i>wch</i>);
</code>
</pre>
</blockquote><h4><a name = "tag_002_001_408">&nbsp;</a>DESCRIPTION</h4><blockquote>
The
<i>bkgrndset()</i>
and
<i>wbkgrndset()</i>
functions turn off
the previous background attributes, OR the requested attributes
into the window rendition, and
set the background property of the current or specified window
based on the information in <i>wch</i>.
<p>
The
<i>bkgrnd()</i>
and
<i>wbkgrnd()</i>
functions turn off
the previous background attributes, OR the requested attributes
into the window rendition, and
set the background property of the current or specified window and
then apply this setting to every character position in that window:
<ul>
<p>
<li>
The rendition of every character on the screen is changed to the new
window rendition.
<p>
<li>
Wherever the former background character appears, it is changed to the new
background character.
<p>
</ul>
<p>
If <i>wch</i> refers to a non-spacing complex character for
<i>bkgrnd()</i>,
<i>bkgrndset()</i>,
<i>wbkgrnd()</i>
and
<i>wbkgrndset()</i>,
then <i>wch</i> is added to the
existing spacing complex character that is the background character.
If <i>wch</i> refers to a multi-column character, the results are unspecified.
<p>
The
<i><a href="getbkgrnd.html">getbkgrnd()</a></i>
and
<i>wgetbkgrnd()</i>
functions store, into the area pointed to by <i>wch</i>, the value of the
window's background character and rendition.
</blockquote><h4><a name = "tag_002_001_409">&nbsp;</a>RETURN VALUE</h4><blockquote>
The
<i>bkgrndset()</i>
and
<i>wbkgrndset()</i>
functions do not return a value.
<p>
Upon successful completion, the other functions return OK.
Otherwise, they return ERR.
</blockquote><h4><a name = "tag_002_001_410">&nbsp;</a>ERRORS</h4><blockquote>
No errors are defined.
</blockquote><h4><a name = "tag_002_001_411">&nbsp;</a>SEE ALSO</h4><blockquote>
<xref href=rendnew><a href="intov.html#tag_001_003_004">
Rendition
</a></xref>,
<i><a href="curses.h.html">&lt;curses.h&gt;</a></i>.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>
